Skip to content

migrated search(route) and search(stop) pages to REST API Method #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

migrated search(route) and search(stop) pages to REST API Method #127

wants to merge 4 commits into from

Conversation

@Ajay9330
Copy link
Contributor

@Ajay9330 Ajay9330 commented Apr 7, 2024 •
edited
Loading

Description:

migration of the two pages and jsoneditor support added for the check please refer to Issued fixed section

  1. page1: https://developer.onebusaway.org/api/where/search/stop
  2. page2: https://developer.onebusaway.org/api/where/search/route

IMP NOTE

i've added the links at the end of instead of the ascending order because these page/methods were little bit different form others

Issue fixed:

  1. The pages which explain working of the searching(routes,stops) are inside the feature>search api>PAGE which can be hidden from the reader.
  2. The pages doesn't have JSONEditor support
  3. The Search is a method which came under the REST API method
    because of above issues I tried to fix all of them by migrating the both pages

Changes done:

  • deleted old search/route and search/stop pages
  • added new pages for both in REST API METHOD
  • added response sample JSON data in for both
  • added description and page name in the rest_api.json
  • correction of links for the both pages
  • added about the response elements

Screenshots/Videos

image

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Tried squashing the commits into one

@Ajay9330
Copy link
Contributor Author

Ajay9330 commented Apr 7, 2024

sir @aaronbrethorst ,
please give a confirmation for adding the response type before merging the PR that

  1. is the https://api.pugetsound.onebusaway.org/api/where/search/route.json?input=crystal&key=TEST returns list of the routes elements?
  2. is the https://api.pugetsound.onebusaway.org/api/where/search/stop.json?input=crystal&key=TEST return list of the stop elements?
    asking these for adding new a commit for the response and its element for the both pages

@Ajay9330 Ajay9330 marked this pull request as ready for review April 8, 2024 08:01
@Ajay9330
Copy link
Contributor Author

Ajay9330 commented Apr 8, 2024

Everything done!
sir @aaronbrethorst , please verify and tell me if there are any changes are required!

aaronbrethorst
aaronbrethorst requested changes Apr 10, 2024
View reviewed changes
Copy link
Member

@aaronbrethorst aaronbrethorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! looks like good progress. I've noted some changes to make below.

src/_data/rest_api.json Outdated
"vehicles-for-agency": {
"description": "get active vehicles for an agency"
},
"search (stop)": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please alphabetize these two methods

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also please rename the new pages to search-stop and search-route

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sir, i need 2 little bit clarifications

  1. either we can keep search-route or Search-Route for the new page name and method name, because the both should be same else it will show 404
  2. we can change page title which can be differ from the page name
    can we keep search-route format everywhere?

@Ajay9330
Copy link
Contributor Author

Ajay9330 commented Apr 10, 2024 •
edited
Loading

ok sir!
I'll fix all of above,
I have to be more focus on the minor mistakes also

@Ajay9330 Ajay9330 marked this pull request as draft April 12, 2024 10:31
@aaronbrethorst
Copy link
Member

this is marked as a draft. is it ready for review again?

@Ajay9330
Copy link
Contributor Author

Ajay9330 commented Apr 12, 2024 •
edited
Loading

i've marked this not ready for the review because if i push it'll create a new commit and i was unable to squash it.
i have made up the changes locally should i push sir?

@aaronbrethorst
Copy link
Member

if you have changes to push, please push them

@Ajay9330
Copy link
Contributor Author

ok sir,

pushed the changes,please verify!

sorry again tried but unable to squash, i tried following

  1. git rebase -i main
  2. change my pick one commit and 's' other mine commit
  3. after this i got conflict and resolved it but showing new commit push
    again gone to previous commit and forced pushed for discarding
    again tried to rebase but got following and confused how to pick for squash
    squash 1,2nd,4th but they are not in sequence(up to bottom)

Screenshot 2024-04-12 232934

@Ajay9330 Ajay9330 marked this pull request as ready for review April 12, 2024 18:11
@Ajay9330 Ajay9330 requested a review from aaronbrethorst April 12, 2024 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aaronbrethorst aaronbrethorst Awaiting requested review from aaronbrethorst

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Ajay9330 @aaronbrethorst